Add example for raw API Server requests #1330
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I noticed a couple of questions around querying the metrics API that a kubelet exposes. A number of different use cases aside from stat queries may require raw requests to the API Server (in the style of `kubectl get --raw`). It does not make much sense to extend the Request API to cover this use case (since an abstraction would not simplify anything). Users can, however, make use of the `http::Request` type and use an instantiated client to interface with the API Server. There's a lack of material here, so I thought I'd include an example that other people may reference. The example builds the equivalent of `kubectl top nodes` (in a simpler, and dumber way) using raw HTTP requests. The data may not be as exact as what `kubectl top` offers, but it serves as an example on how data may be queried. Signed-off-by: Matei David <[email protected]>
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #1330 +/- ##
=======================================
- Coverage 72.4% 72.1% -0.2%
=======================================
Files 75 75
Lines 6343 6377 +34
=======================================
+ Hits 4586 4597 +11
- Misses 1757 1780 +23 |
clux
reviewed
Oct 28, 2023
* Remove redundant `.items` acess. * Rename NodeMetric to NodeMetrics * std::cmp instead of manually comparing. Co-authored-by: Eirik A <[email protected]> Signed-off-by: Matei David <[email protected]>
Signed-off-by: Matei David <[email protected]>
…nto matei/add-raw-example
Signed-off-by: Matei David <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
I noticed a couple of questions around querying the metrics API that a kubelet exposes. A number of different use cases aside from stat queries may require raw requests to the API Server (in the style of
kubectl get --raw).It does not make much sense to extend the Request API to cover this use case (since an abstraction would not simplify anything). Users can, however, make use of the
http::Requesttype and use an instantiated client to interface with the API Server. There's a lack of material here, so I thought I'd include an example that other people may reference.Solution
The example builds the equivalent of
kubectl top nodes(in a simpler, and dumber way) using raw HTTP requests. The data may not be as exact as whatkubectl topoffers, but it serves as an example on how data may be queried.If this isn't needed, I'm happy to put it in a gist somewhere, no time wasted so no worries there :) It is an unsolicited PR.